Skip to main content
Minh Nong
💬
0 discussions

[API] record-service

Tài liệu này nhằm mục đích quản lý số lượng và chức năng của endpoints trong record-service. Người đọc có thể dựa vào tên của files và tên endpoints để dễ dàng kiểm tra thông tin apis source code.

API Endpoints

domain.js

Create domain

  • Route: /domain
  • Method: POST
  • Params: ``
  • Query: versionSchema
  • Body: req.bodyReturn Format:
  • Success: 200 { success: true, result }
  • Failure: 400 { success: false, error: { message: error } }

Query domains

  • Route: /domains/all
  • Method: GET
  • Params: ``
  • Query: req.query
  • Body: `` Return Format:
  • Success: 200 { success: true, result }
  • Failure: 400 { success: false, error: { message: error } }

Delete domains

  • Route: /domains/all
  • Method: DELETE
  • Params: ``
  • Query: versionSchema
  • Body: req.bodyReturn Format:
  • Success: 200 { success: true }
  • Failure: 400 { success: false, error: { message: error } }

Update domain

  • Route: /domain/:id
  • Method: PUT
  • Params: id
  • Query: versionSchema
  • Body: req.bodyReturn Format:
  • Success: 200 { success: true, result }
  • Failure: 400 { success: false, error: { message: error } }

Delete domain

  • Route: /domain/:id
  • Method: DELETE
  • Params: id
  • Query: versionSchema
  • Body: req.bodyReturn Format:
  • Success: 200 { success: true }
  • Failure: 400 { success: false, error: { message: error } }

pbx.js

Create pbx

  • Route: /pbx
  • Method: POST
  • Params: ``
  • Query: versionSchema
  • Body: `` Return Format:
  • Success: 200 { success: true, result }
  • Failure: 400 { success: false, error: { message: error } }

Query pbxs

  • Route: /pbxs/all
  • Method: GET
  • Params: ``
  • Query: req.query
  • Body: `` Return Format:
  • Success: 200 { success: true, result }
  • Failure: 400 { success: false, error: { message: error } }

Get pbxs

  • Route: /pbx/:id
  • Method: GET
  • Params: id
  • Query: ``
  • Body: `` Return Format:
  • Success: 200 { success: true, result }
  • Failure: 400 { success: false, error: { message: error } }

Delete pbx

  • Route: /pbx/:id
  • Method: DELETE
  • Params: id
  • Query: versionSchema
  • Body: `` Return Format:
  • Success: 200 { success: true, result }
  • Failure: 400 { success: false, error: { message: error } }

tel4vn.js

https://pbxdocs.gcalls.co/

Login

  • Route: /v3/auth
  • Method: POST
  • Params: ``
  • Query: ``
  • Body: username, passwordReturn Format:
  • Success: 200 response.data.data
  • Failure: 400 { success: false, error: { message: error } }

Get Token

  • Route: /v3/auth/token
  • Method: POST
  • Params: ``
  • Query: ``
  • Body: api_keyReturn Format:
  • Success: 200 response.data
  • Failure: 400 { success: false, error: { message: error } }

Get List Domain

  • Route: /v3/domain
  • Method: GET
  • Params: ``
  • Query: limit, offset
  • Body: `` Return Format:
  • Success: 200 response.data.data
  • Failure: 400 { success: false, error: { message: error } }

Get Call Log

  • Route: /v3/cdr
  • Method: GET
  • Params: ``
  • Query: limit, offset, start_date, end_date
  • Body: `` Return Format:
  • Success: 200 response.data.data
  • Failure: 400 { success: false, error: { message: error } }

Get Call Log By Call ID

  • Route: /v3/cdr/:id
  • Method: GET
  • Params: id
  • Query: ``
  • Body: `` Return Format:
  • Success: 200 { success: true, data }
  • Failure: 400 { success: false, error: { message: error } }